The Scan Destination SMB Module

With the SMB module, a scan can be made to a directory, whereby the file transfer takes place with the SMB protocol (Server Message Block). The module can occur several times in the workflow. This can be useful, for example, if the destination is a fixed preset. Depending on the setting, the user can fill or change the fields on the device. The access data defined in this dialog are used for access to the destination directory via SMB (if these data are not specified, those of the user who is running the ImageService are used).

You can test the access to the directory with the Save test file via SMB button. An attempt is made to save a simple text file with the current settings of the SMB module in the destination directory - a message appears stating whether this worked or not.

The modules for the scan destinations are arranged on the device in exactly the same way as in the workflow (X-axis; the left-most scan destination is also displayed on the left-most device).

You can use variables in all input fields, see Variables.

The module can occur several times in the workflow.

Scanning module on the device

Image enhancement module

The Document Processing Module

The module can be connected to all modules (this can result in nonsensical workflows).

No restrictive modules.

If this option is enabled, the destination is initially selected in the scan dialog on the device.

When this option is disabled, the scan destination is not displayed on the device. It can still be preselected as a destination.

This field is used to specify the name that the scan file should be given.

Presetting: You can preset the field with a value or a setting. For required fields, which might not be changeable or visible, a presetting is absolutely necessary.

Properties:

  • Can be changed: If this setting is enabled, the user can enter something in the field or change the default preset. If the setting is not enabled, the field is grayed out and the content is visible but cannot be changed.
  • Visible: If this option is disabled, the input field is not visible for the user - accordingly, nothing can be entered (note the default setting).
  • Required field: If this option is enabled, the workflow cannot be continued until the user has made an entry. Presetting and/or visibility should be considered in this context.

With this switch you can specify whether a timestamp consisting of the date and time is to be appended to the name from File Name. Alternatively, you can use date and time variables in the File Name field.

Presetting: You can preset the field with a value or a setting. For required fields, which might not be changeable or visible, a presetting is absolutely necessary.

Properties:

  • Can be changed: If this setting is enabled, the user can enter something in the field or change the default preset. If the setting is not enabled, the field is grayed out and the content is visible but cannot be changed.
  • Visible: If this option is disabled, the input field is not visible for the user - accordingly, nothing can be entered (note the default setting).
  • Required field: If this option is enabled, the workflow cannot be continued until the user has made an entry. Presetting and/or visibility should be considered in this context.

In this field, enter the destination directory where the final scan file should be saved. The directory can be specified both as a local path and as a UNC (share) path. For local paths, the server on which the ImageService is installed is assumed.

It is possible to activate a directory search here. The specified destination directory is then used as the root directory, which then represents the top directory level in the interface for the user. On the device, if the Embedded Client is installed, the user can then select the destination directory from a directory structure, see My Scan Menu. Which directory depth (and thus resulting visible subfolders) is visible in the Embedded Client can be defined in the Workflow module via the max. directory depth.

Presetting: You can preset the field with a value or a setting. For required fields, which might not be changeable or visible, a presetting is absolutely necessary.

Properties:

  • Can be changed: If this setting is enabled, the user can enter something in the field or change the default preset. If the setting is not enabled, the field is grayed out and the content is visible but cannot be changed.
  • Visible: If this option is disabled, the input field is not visible for the user - accordingly, nothing can be entered (note the default setting).
  • Required field: If this option is enabled, the workflow cannot be continued until the user has made an entry. Presetting and/or visibility should be considered in this context.

The username for accessing the directory on the target server must be entered in this field.

Presetting: You can preset the field with a value or a setting. For required fields, which might not be changeable or visible, a presetting is absolutely necessary.

Properties:

  • Can be changed: If this setting is enabled, the user can enter something in the field or change the default preset. If the setting is not enabled, the field is grayed out and the content is visible but cannot be changed.
  • Visible: If this option is disabled, the input field is not visible for the user - accordingly, nothing can be entered (note the default setting).
  • Required field: If this option is enabled, the workflow cannot be continued until the user has made an entry. Presetting and/or visibility should be considered in this context.

The user's password is entered in this field (for access to the destination directory).

Presetting: You can preset the field with a value or a setting. For required fields, which might not be changeable or visible, a presetting is absolutely necessary.

Properties:

  • Can be changed: If this setting is enabled, the user can enter something in the field or change the default preset. If the setting is not enabled, the field is grayed out and the content is visible but cannot be changed.
  • Visible: If this option is disabled, the input field is not visible for the user - accordingly, nothing can be entered (note the default setting).
  • Required field: If this option is enabled, the workflow cannot be continued until the user has made an entry. Presetting and/or visibility should be considered in this context.

You can choose how the login via SMB should work. Some methods might be prohibited due to a security policy (for example, the default method Interactive). You can restore the default settings Interactive and Impersonation with the Set Defaults button.

More information about the following login methods can be found in the Microsoft documentation:
https://docs.microsoft.com/en-us/windows/security/threat-protection/auditing/basic-audit-logon-events

Setting Type Number (Windows) Description

Batch

 4 (Batch Job) E.g. in combination with a batch job that is executed as another user.

Network

 3 (Network) E.g. to access a network drive

Interactive

 2 (Interactive) E.g. to log in to another computer (also for access to a network drive)

Network not encrypted

 8 (NetworkCleartext) Network login data are transmitted in plaintext

New credentials

 9 (NewCredentials) Allows the accessing party to clone their current access token for access to a network drive, for example

Service

 5 (Service) E.g. in combination with a service (service runs under this account)

Unlock

 7 (Unlock) Access to a computer equipped with a password-protected screen saver

For a description of the Windows methods, please refer to the Microsoft documentation:
https://docs.microsoft.com/de-de/windows/desktop/com/impersonation-levels

Setting Type (Windows)

Anonymous

 anonymous (RPC_C_IMP_LEVEL_ANONYMOUS)

Impersonation

 impersonate (RPC_C_IMP_LEVEL_IMPERSONATE)

Delegation

 delegate (RPC_C_IMP_LEVEL_DELEGATE)

Identification

 identify (RPC_C_IMP_LEVEL_IDENTIFY)

A semaphore is a kind of signal generator for a related process (which signals that a process has been completed). A semaphore file can be written as a signal. This is an empty file that usually has the same name as the file for which processing is to be continued (the scan file). The semaphore file is transferred to the scan destination location in addition to the scan file (e.g. is stored in the same folder).

Semaphore file name: Specify the name of the semaphore file with file extension. If no variables are used in the name (e.g. semaphorefile.xml), the file will always be overwritten during transfer via FTP if it already exists. For SMB, an additional number is inserted in the name (e.g. semaphorefile (1).xml). All variables can be used in the name, see Variables.

A text-based metafile can be created for the actual destination file. This file is then transferred to the destination location in addition to the destination file (e.g. is stored in the same folder).

Encoding: Set which encoding method should be used to create the text file. The following encoding methods are available (please contact your IQ4docs contact if you require an encoding method that is not currently offered):

  • UTF-8
  • UTF-8 with BOM
  • UTF-16 big endian
  • UTF-16 little endian
  • UTF-32 big endian
  • UTF-32 little endian
  • ASCII
  • ISO 8859-15
  • Windows-1252

Note that not all (special) characters can be displayed correctly with every encoding method. Characters that cannot be displayed may be replaced by other characters.

Metafile name: Specify the name of the metafile with file extension. If no variables are used in the name (e.g. metafile.xml), the file will always be overwritten during transfer via FTP if it already exists. For SMB, an additional number is inserted in the name (e.g. metafile (1).xml). All variables can be used in the name, see Variables.

Metafile content: Use this field to define the content of the metafile. All Variables can be used in the content of the metafile. In connection with this, please also note the possibilities of Zone OCR, see Zone OCR, Barcode, QRCode module.

The ImageService processes image data (e.g. from scans) and performs file format conversions, image optimization and the OCR function. It stores files in desired destination directories (depending on the module used, the rights of the user executing its application pool are used for this purpose). Its log file is Logs\ImageService.log.